<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>keyrange.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_db_keyrange.js.html">keyrange.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2012 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Wrapper for a IndexedDB key range.
<a name="line17"></a> *
<a name="line18"></a> */
<a name="line19"></a>
<a name="line20"></a>
<a name="line21"></a>goog.provide(&#39;goog.db.KeyRange&#39;);
<a name="line22"></a>
<a name="line23"></a>
<a name="line24"></a>
<a name="line25"></a>/**
<a name="line26"></a> * Creates a new IDBKeyRange wrapper object. Should not be created directly,
<a name="line27"></a> * instead use one of the static factory methods. For example:
<a name="line28"></a> * @see goog.db.KeyRange.bound
<a name="line29"></a> * @see goog.db.KeyRange.lowerBound
<a name="line30"></a> *
<a name="line31"></a> * @param {!IDBKeyRange} range Underlying IDBKeyRange object.
<a name="line32"></a> * @constructor
<a name="line33"></a> */
<a name="line34"></a>goog.db.KeyRange = function(range) {
<a name="line35"></a>  /**
<a name="line36"></a>   * Underlying IDBKeyRange object.
<a name="line37"></a>   *
<a name="line38"></a>   * @type {!IDBKeyRange}
<a name="line39"></a>   * @private
<a name="line40"></a>   */
<a name="line41"></a>  this.range_ = range;
<a name="line42"></a>};
<a name="line43"></a>
<a name="line44"></a>
<a name="line45"></a>/**
<a name="line46"></a> * The IDBKeyRange.
<a name="line47"></a> * @type {!Object}
<a name="line48"></a> * @private
<a name="line49"></a> */
<a name="line50"></a>goog.db.KeyRange.IDB_KEY_RANGE_ = goog.global.IDBKeyRange ||
<a name="line51"></a>    goog.global.webkitIDBKeyRange;
<a name="line52"></a>
<a name="line53"></a>
<a name="line54"></a>/**
<a name="line55"></a> * Creates a new key range for a single value.
<a name="line56"></a> *
<a name="line57"></a> * @param {IDBKeyType} key The single value in the range.
<a name="line58"></a> * @return {!goog.db.KeyRange} The key range.
<a name="line59"></a> */
<a name="line60"></a>goog.db.KeyRange.only = function(key) {
<a name="line61"></a>  return new goog.db.KeyRange(goog.db.KeyRange.IDB_KEY_RANGE_.only(key));
<a name="line62"></a>};
<a name="line63"></a>
<a name="line64"></a>
<a name="line65"></a>/**
<a name="line66"></a> * Creates a key range with upper and lower bounds.
<a name="line67"></a> *
<a name="line68"></a> * @param {IDBKeyType} lower The value of the lower bound.
<a name="line69"></a> * @param {IDBKeyType} upper The value of the upper bound.
<a name="line70"></a> * @param {boolean=} opt_lowerOpen If true, the range excludes the lower bound
<a name="line71"></a> *     value.
<a name="line72"></a> * @param {boolean=} opt_upperOpen If true, the range excludes the upper bound
<a name="line73"></a> *     value.
<a name="line74"></a> * @return {!goog.db.KeyRange} The key range.
<a name="line75"></a> */
<a name="line76"></a>goog.db.KeyRange.bound = function(lower, upper, opt_lowerOpen, opt_upperOpen) {
<a name="line77"></a>  return new goog.db.KeyRange(goog.db.KeyRange.IDB_KEY_RANGE_.bound(
<a name="line78"></a>      lower, upper, opt_lowerOpen, opt_upperOpen));
<a name="line79"></a>};
<a name="line80"></a>
<a name="line81"></a>
<a name="line82"></a>/**
<a name="line83"></a> * Creates a key range with a lower bound only, finishes at the last record.
<a name="line84"></a> *
<a name="line85"></a> * @param {IDBKeyType} lower The value of the lower bound.
<a name="line86"></a> * @param {boolean=} opt_lowerOpen If true, the range excludes the lower bound
<a name="line87"></a> *     value.
<a name="line88"></a> * @return {!goog.db.KeyRange} The key range.
<a name="line89"></a> */
<a name="line90"></a>goog.db.KeyRange.lowerBound = function(lower, opt_lowerOpen) {
<a name="line91"></a>  return new goog.db.KeyRange(goog.db.KeyRange.IDB_KEY_RANGE_.lowerBound(
<a name="line92"></a>      lower, opt_lowerOpen));
<a name="line93"></a>};
<a name="line94"></a>
<a name="line95"></a>
<a name="line96"></a>/**
<a name="line97"></a> * Creates a key range with a upper bound only, starts at the first record.
<a name="line98"></a> *
<a name="line99"></a> * @param {IDBKeyType} upper The value of the upper bound.
<a name="line100"></a> * @param {boolean=} opt_upperOpen If true, the range excludes the upper bound
<a name="line101"></a> *     value.
<a name="line102"></a> * @return {!goog.db.KeyRange} The key range.
<a name="line103"></a> */
<a name="line104"></a>goog.db.KeyRange.upperBound = function(upper, opt_upperOpen) {
<a name="line105"></a>  return new goog.db.KeyRange(goog.db.KeyRange.IDB_KEY_RANGE_.upperBound(
<a name="line106"></a>      upper, opt_upperOpen));
<a name="line107"></a>};
</pre>


</body>
</html>
